[DSDK-80] Define project structure (file tree) #2

jdabbech-ledger · 2023-12-15T16:14:31Z

📝 Description

Setup project structure
Add sample app & packages with turborepo

❓ Context

JIRA or GitHub link: DSDK-80 DSDK-12 DSDK-146 DSDK-59 DSDK-61 DSDK-65 DSDK-64

✅ Checklist

Pull Requests must pass the CI and be code reviewed. Set as Draft if the PR is not ready.

npx changeset was attached.
Covered by automatic tests.
Impact of the changes:
- setup turborepo with sample apps and packages @ledgerhq/device-sdk-core @ledgerhq/device-sdk-signer @ledgerhq/device-sdk-trustap-apps @ledgerhq/device-sdk-ui
- packages/cores/script/add-feature.mjs script to create folders of a new feature in ledgerhq/device-sdk-core.
- setup sample app with create-next-app
- setup packages folder structure:

packages
├── config
│   ├── eslint
│   │   ├── index.js
│   |   ├── package.json // @ledgerhq/eslint-config-dsdk
|   ├── typescript
|   │   ├── package.json // @ledgerhq/tsconfig-dsdk
|   │   ├── sdk.json
|   │   └── web.json
├── core
│   ├── package.json // @ledgerhq/device-sdk-core
│   ├── scripts
│   │   └── add-feature.mjs
│   ├── src
│   │   ├── api
│   │   ├── common
│   │   ├── device-action
│   │   ├── shared
│   │   │   ├── entities
│   │   │   └── utils
│   │   └── transport
│   └── tests
├── signer
│   ├── package.json // @ledgerhq/device-sdk-signer
│   ├── src
│   └── tests
├── trusted-apps
│   ├── package.json // @ledgerhq/device-sdk-trustap-apps
│   ├── src
│   └── tests
└── ui
    ├── package.json // @ledgerhq/device-sdk-ui
    ├── src
    └── tests

🧐 Checklist for the PR Reviewers

The code aligns with the requirements described in the linked JIRA or GitHub issue.
The PR description clearly documents the changes made and explains any technical trade-offs or design decisions.
There are no undocumented trade-offs, technical debt, or maintainability issues.
The PR has been tested thoroughly, and any potential edge cases have been considered and handled.
Any new dependencies have been justified and documented.
Performance considerations have been taken into account. (changes have been profiled or benchmarked if necessary)

mbertin-ledger

Maybe we could handle the retun live :)

.github/workflows/main.yml

apps/sample/src/App.tsx

packages/core/scripts/add-feature.mjs

packages/core/src/api/DeviceSdk.ts

mbertin-ledger · 2023-12-18T16:28:40Z

turbo.json

+      "persistent": true
+    }
+  }
+}


As describe above for github actions.
We could define here, pull_request_develop entry here for pipelines

Like a test entry that depends on build & lint and execute test in each packages? I guess a naming pull_request should only designate a git workflow step

packages/core/.eslintrc.js

.gitignore

packages/core/.eslintrc.js

.github/workflows/pull_request.yml

package.json

packages/config/eslint/package.json

packages/core/scripts/add-feature.mjs

packages/core/src/transport/Transport.ts

packages/core/src/transport/model/Response.ts

ofreyssinet-ledger · 2024-01-04T16:12:40Z

packages/core/package.json

+    "dev": "tsc --watch",
+    "lint": "eslint --cache --ext .ts \"src\"",
+    "lint:fix": "eslint --cache --fix --ext .ts \"src\"",
+    "feature": "zx scripts/add-feature.mjs",


[COULD] could you maybe document this script in the README.md ? (the other ones are pretty classic so not needed I think)

this script seems like a nice addition 👍

ofreyssinet-ledger

great job overall! lgtm 👍
maybe a small readme in explaining how to setup the project, its structure, the different packages, explaining the main commands, explaining the dependencies (node version for instance) would be nice. But it can also be done as a separate task I think, this is already a lot 👍

aussedatlo · 2024-01-05T14:14:04Z

lgtm 👍

[DSDK-67] Setup unit test

alexandremgo · 2024-01-17T10:57:38Z

packages/config/typescript/sdk.json

+  "extends": "@tsconfig/recommended/tsconfig.json",
+  "compilerOptions": {
+    "target": "esnext",
+    "lib": ["esnext", "dom"],


Do we need dom ? Maybe if we have a package that export React hooks wrapping our action maybe ?

I added this in order to allow the usage of console in DSDK ts

alexandremgo · 2024-01-17T11:01:00Z

packages/core/scripts/add-feature.mjs

+      await $`touch entities/.gitkeep data/.gitkeep use-cases/.gitkeep repository/.gitkeep`;
+    });
+  }
+});


jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch from d1f8ae2 to 551ec87 Compare December 18, 2023 12:30

jdabbech-ledger changed the base branch from main to develop December 18, 2023 15:55

mbertin-ledger requested changes Dec 18, 2023

View reviewed changes

jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch 9 times, most recently from a7d99f0 to ebfb252 Compare December 20, 2023 10:32

jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch from 95d8bd0 to d70dafb Compare December 27, 2023 11:58

mbertin-ledger approved these changes Jan 2, 2024

View reviewed changes

packages/core/.eslintrc.js Show resolved Hide resolved

jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch from ded522b to 6e0586a Compare January 2, 2024 16:53

jdabbech-ledger changed the base branch from develop to main January 2, 2024 17:37

jdabbech-ledger changed the base branch from main to develop January 2, 2024 17:37

jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch from a3453c1 to a0073ed Compare January 3, 2024 15:39

valpinkman requested changes Jan 4, 2024

View reviewed changes

ofreyssinet-ledger reviewed Jan 4, 2024

View reviewed changes

ofreyssinet-ledger approved these changes Jan 4, 2024

View reviewed changes

mbertin-ledger requested review from alexandremgo and aussedatlo January 4, 2024 16:52

aussedatlo approved these changes Jan 16, 2024

View reviewed changes

jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch 3 times, most recently from 5ea0006 to 7d30cc5 Compare January 16, 2024 14:37

valpinkman approved these changes Jan 16, 2024

View reviewed changes

chore: init sample app with simple ble discovery

bb09b4e

jdabbech-ledger and others added 19 commits January 17, 2024 09:01

chore: init packages folders structure

8a885b1

chore: init turbo monorepo

ab76bcb

chore(sample): eject react app

b1dd273

chore: build & dev packages

34fa3b4

chore: update .gitignore

3715dbf

chore: turbo build & dev

f988392

chore: fix ci

5ac9ec1

chore: review ci

6a04b8f

chore: tsconfig as a module

d386dcd

fix: lint

78bc0c6

refactor: mv config packages in separate folder

f75b462

fix: missing empty lines

4b25a4a

chore: inversify instead of tsyring

4f7e9e1

chore: clean .gitkeep & review

cc09a77

fix(packages): files export

7d5ab24

chore(setup): review

75f2b87

chore: add case for .mjs files + zx typings

2626cc8

chore: fix wrong envs in eslint config

024c66c

chore: finetune zx eslint support

2c443d1

jdabbech-ledger force-pushed the feature/DSDK-80-setup-file-structure branch from 481012a to 2c443d1 Compare January 17, 2024 08:01

jdabbech-ledger and others added 4 commits January 17, 2024 09:03

chore: setup jest with shared config

6c0c4fe

chore(ci): 2 jobs and common composite

3d6f2cd

chore: improve Readme

a41c52a

Merge pull request #4 from LedgerHQ/feature/DSDK-67-setup-jest

1d8aca8

[DSDK-67] Setup unit test

valpinkman approved these changes Jan 17, 2024

View reviewed changes

alexandremgo reviewed Jan 17, 2024

View reviewed changes

alexandremgo approved these changes Jan 17, 2024

View reviewed changes

jdabbech-ledger merged commit 9a6ae56 into develop Jan 17, 2024
2 checks passed

jdabbech-ledger deleted the feature/DSDK-80-setup-file-structure branch January 17, 2024 14:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DSDK-80] Define project structure (file tree) #2

[DSDK-80] Define project structure (file tree) #2

jdabbech-ledger commented Dec 15, 2023 •

edited by jira bot

Loading

mbertin-ledger left a comment

mbertin-ledger Dec 18, 2023

jdabbech-ledger Dec 19, 2023 •

edited

Loading

ofreyssinet-ledger Jan 4, 2024

ofreyssinet-ledger Jan 4, 2024 •

edited

Loading

ofreyssinet-ledger left a comment

aussedatlo commented Jan 5, 2024

alexandremgo Jan 17, 2024

jdabbech-ledger Jan 17, 2024 •

edited

Loading

alexandremgo Jan 17, 2024

[DSDK-80] Define project structure (file tree) #2

[DSDK-80] Define project structure (file tree) #2

Conversation

jdabbech-ledger commented Dec 15, 2023 • edited by jira bot Loading

📝 Description

❓ Context

✅ Checklist

🧐 Checklist for the PR Reviewers

mbertin-ledger left a comment

Choose a reason for hiding this comment

mbertin-ledger Dec 18, 2023

Choose a reason for hiding this comment

jdabbech-ledger Dec 19, 2023 • edited Loading

Choose a reason for hiding this comment

ofreyssinet-ledger Jan 4, 2024

Choose a reason for hiding this comment

ofreyssinet-ledger Jan 4, 2024 • edited Loading

Choose a reason for hiding this comment

ofreyssinet-ledger left a comment

Choose a reason for hiding this comment

aussedatlo commented Jan 5, 2024

alexandremgo Jan 17, 2024

Choose a reason for hiding this comment

jdabbech-ledger Jan 17, 2024 • edited Loading

Choose a reason for hiding this comment

alexandremgo Jan 17, 2024

Choose a reason for hiding this comment

jdabbech-ledger commented Dec 15, 2023 •

edited by jira bot

Loading

jdabbech-ledger Dec 19, 2023 •

edited

Loading

ofreyssinet-ledger Jan 4, 2024 •

edited

Loading

jdabbech-ledger Jan 17, 2024 •

edited

Loading